home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
JCSM Shareware Collection 1996 September
/
JCSM Shareware Collection (JCS Distribution) (September 1996).ISO
/
fileutil
/
supdir11.zip
/
SDIR.DOC
< prev
next >
Wrap
Text File
|
1995-08-23
|
20KB
|
492 lines
SuperDIR (tm)
Directory List Program.
Copyright 1995 Cottonwood Software.
All Rights Reserved
Users Manual
Version 1.11
23 Aug 1995
_______
____|__ | (R)
--| | |-------------------
| ____|__ | Association of
| | |_| Shareware
|__| o | Professionals
-----| | |---------------------
|___|___| MEMBER
'SuperDIR' Directory List Program
About SuperDIR
---------------
SuperDIR is a powerful directory lister with some unusual output options,
including:
- Comma-, Tab- and Space-delimited output options for import to databases
- Sorting files throughout directories (rather than just within the dir.)
- Multiple include and exclude filters for files and directory names
- Multiple paths/drives may be searched at once (registered version only)
- Indenting by directory level
SuperDIR was designed for creating directory listings for import into
spreadsheets or database programs. The primary use is to make a
complete file database of shareware CD-ROMs, for use by a shareware
cataloging/extraction program.
It is also useful in finding duplicate files on a disk, as well as being
a good general-purpose DIR replacement with multiple include/exclude
capabilities.
The other intent was to 'showcase' some general C++ programming methods
such as objects, recursive objects, subclassing, encapsulation, etc.
As a result of these objectives, there are no fancy graphical interfaces
in SuperDIR; just a hard-working program that spits out directory lines
one at a time.
You will get the complete source code when you register SuperDIR.
The code is highly-modularized C++, which could be used in any number
of projects that need directory information. It also makes use of some
general-purpose C++ class objects such as a command-line argument
parser class and a linked-list class.
(See the section 'Registering' and ORDER.FRM for more information.)
*************************************************************************
*** This program is shareware! Feel free to use it and distribute it ***
*** wherever you like, as long as you distribute the program in its ***
*** original and complete form. (Vendors, see VENDOR.DOC.) ***
*** ***
*** If you like this program and intend to use it often, then please ***
*** register (see below). You will be notified of any updates and ***
*** bug fixes automatically as a registred user. And besides, it's ***
*** the right thing to do! ***
*************************************************************************
Cottonwood Software is a member of the Association of Shareware
Professionals (ASP). ASP wants to make sure that the shareware
principle works for you. If you are unable to resolve a
shareware-related problem with an ASP member by contacting the member
directly, ASP may be able to help. The ASP Ombudsman can help you
resolve a dispute or problem with an ASP member, but does not provide
technical support for members' products. Please write to the ASP
Ombudsman at 545 Grover Road, Muskegon, MI USA 49442-9427, Fax
616-788-2765, or send a CompuServe message via CompuServe Mail to ASP
Ombudsman 70007,3536."
Packing List, Shareware Version
-------------------------------
You should have the following files:
SDIR.EXE The SuperDIR program
SDIR.DOC This manual
README.1ST Short introduction/instructions
ORDER.FRM Registration/order form
FILE_ID.DIZ Program description
VENDOR.DOC Vendor information
REVISION.TXT Revision history
If any of these files are missing, please let your distributor know,
and contact the author to find out where to get a complete copy free
of charge. (See 'Suggestions...' below)
System Requirements
-------------------
To run SuperDIR, you need:
IBM PC/XT/AT compatible computer (8088 or higher processor)
MS-DOS 3.0 or higher (untested on lower versions)
At least 256K free RAM
Windows Users:
--------------
SuperDIR may be run from a Windows DOS box (Command Prompt). However,
this usually results in less memory available. See the section
'Limitations' for more information. A full Windows version is in the
works. (Ask to be put on our mailing list for a free advance copy.)
This manual assumes general knowledge about PC's and the DOS operating
system. There are many good books available that teach the basics of DOS
in your local bookstore or library.
Installing and Running SuperDIR
-------------------------------
To install SuperDIR, copy the files to a suitable location on your hard
disk, creating a new directory if necessary.
For example:
(This assumes that your current directory is where you now have SuperDIR)
MD C:\SDIR
COPY *.* C:\SDIR
To run SuperDIR, simply type the program name (SDIR) at the DOS command
prompt. Make sure you are in the directory containing the program, or
have the directory included in your PATH statement. For more information,
refer to your MS-DOS or PC-DOS user's manual.
To get a list of commands, type "SDIR /?" at the command prompt.
*********** IMPORTANT WARRANTY INFORMATION **********
TRIAL USE (SHAREWARE EVALUATION VERSION) WARRANTY:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The Shareware evaluation (trial use) version is
provided AS IS. Cottonwood Software MAKES NO WARRANTY OF
ANY KIND, EXPRESSED OR IMPLIED, INCLUDING WITHOUT LIMITATION,
ANY WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE.
REGISTERED VERSION LIFETIME WARRANTY:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Cottonwood Software warrants the physical diskette(s) and
physical documentation provided with registered versions to
be free of defects in materials and workmanship. If Cottonwood
Software receives notification of defects in materials or
workmanship, and such notification is determined by Cottonwood
Software to be correct, Cottonwood Software will replace the
defective diskette(s) or documentation.
The entire and exclusive liability and remedy for
breach of this Warranty shall be limited to replacement of
defective diskette(s) or documentation and shall not include
or extend to any claim for or right to recover any other
damages, including but not limited to, loss of profit, data,
or use of the software, or special, incidental, or consequential
damages or other similar claims, even if Cottonwood Software
has been specifically advised of the possibility of such damages.
In no event will Cottonwood Software's liability for any damages
to you or any other person ever exceed the lower of suggested
list price or actual price paid for the license to use the
software, regardless of any form of the claim.
Cottonwood Software SPECIFICALLY DISCLAIMS ALL OTHER
WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
TO, ANY IMPLIED WARRANTY OF MERCHANTABILITY AND/OR FITNESS
FOR A PARTICULAR PURPOSE.
*********** IMPORTANT WARRANTY INFORMATION **********
Registering SuperDIR
--------------------
When you register this program, you not only get a version with all
'Unregistered' reminders removed, you get the complete source code which
will compile with Borland C++. This code may be used freely for your own
projects, or included in a non-competing product for resale, without any
license or royalties required. (We do ask that you notify us if it's
used in a retail product, but we require no credits, license, or other
reporting.)
Benefits of registering:
Multiple-paths-at-once feature enabled (search all drives at once!)
The latest version as of the day you register, with no 'reminders'.
A printed manual.
A quick-reference card.
Full C++ source code for Borland C++ 3.1.
Free copy of another shareware program, CommEx. (Windows enhancement)
Notification of bug fixes and update releases when available.
Big discounts on updates and other products.
A good feeling that you're helping to support the shareware industry!
To register, send $17.00 (U.S.) plus $3.00 S&H ($5.00 S&H outside the U.S.
or Canada) to:
Cottonwood Software
P.O. Box 6546
Leawood, KS 66206-0546 USA
Please pay by check in U.S. funds drawn on a U.S. Bank, by international
money order, or in U.S. currency.
(Do not send credit card orders to this address! See below for c.c. orders.)
You may also register online through Compuserve: GO SWREG, product #5329.
All orders are usually shipped within 24 hours.
CREDIT CARD ORDERS ONLY -
You can order with MC, Visa, Amex, or Discover from Public (software)
Library by calling 800-2424-PsL or 713-524-6394 or by FAX to 713-524-6398
or by CIS Email to 71355,470. You can also mail credit card orders to PsL
at P.O.Box 35705, Houston, TX 77235-5705.
Please refer to product ID #11950
THE ABOVE NUMBERS ARE FOR CREDIT CARD ORDERS ONLY.
THE AUTHOR OF THIS PROGRAM CANNOT BE REACHED AT THESE NUMBERS.
Any questions about the status of the shipment of the order, refunds,
registration options, product details, technical support, volume
discounts, dealer pricing, site licenses, non-credit card orders, etc,
must be directed to Cottonwood Software (see Suggestions... below).
To insure that you get the latest version, PsL will notify us the day of
your order and we will ship the product directly to you the same or next
day.
Suggestions, Comments, and Technical Support
--------------------------------------------
Any suggestions, comments, support questions and bug reports are welcome
and encouraged! All questions will be answered promptly. If you report
a bug, you will get a free updated copy in the mail (or however is most
convenient for us both) when the problem is fixed. This is offered to both
registered and unregistered users because we appreciate the assistance
in making the program better!
The author may be reached at any of the following. (E-mail is preferred)
Compuserve: 75264,1630
Internet: 75264.1630@compuserve.com
WWW Home Page: http//delta.com/cotton/cotton.htm
Voice phone: (913) 663-3022
FAX: (913) 663-3747
Mail: P.O. Box 6546 Leawood, KS 66206-0546 USA
Support is offered at no charge for both registered and unregistered users,
for an unlimited time. (Unregistered users must use E-mail or call us so we
don't incurr long-distance phone expenses.)
If your version is not current, however, you will be asked to obtain the
newest version before any extensive support is given, so we know that any
problems you're having have not already been fixed. We will tell you how
and where to get the latest shareware version, or we can send you the latest
version for a $3.00 handling fee ($5.00 outside the U.S.).
Using SuperDIR -- Command Summary
---------------------------------
Command format:
SDIR [Path [Path]...] [switches]
If no Path or switches are given, it works similar to DOS's DIR command.
[Path] can include drive/directory and/or filename mask, like DOS's DIR.
Multiple paths, even on different drives, may be specified if you're using
the registered version of SuperDIR. Up to 10 paths are allowed. Only the
first path can have a file name or mask.
Note: The /I switch will override (cancel) any file spec given in [path]
To direct output to a file for use by other programs, use the DOS
redirection facility (>), like this:
SDIR [Path] [switches] >filename
It's a good idea to do it without redirection first to make sure it looks
the way you expect. Also, avoid using the /P (pause) switch when
redirecting.
Switch summary:
These can be either upper or lower case.
Some accept '-' prefix to turn off the switch, as noted below.
/I Include file filters (up to 10, sep. by semicolons, no spaces)
example: /I*.c;*.h;sdir.*
Note: This will override any file spec in [path]
/X Exclude file filters (up to 10, sep. by semicolons, no spaces)
example: /X*.bak;*.obj;temp*.*
/D Include directory filters (up to 10, sep. by semicolons, no spaces)
example: /Dwin*;word
/E Exclude directory filters (up to 10, sep. by semicolons, no spaces)
example: /Etemp;tmp;dos;util;bat
/S Subdirectories (traverses all subdirectory levels)
/. (Default) Include . and .. subdirectories, or use /-. to turn off
/P Pause after 24 lines, or /Pnn to pause after nn lines
/L Output all lower-case (path and filename) Upper case is default.
/? Displays help message
/H Displays help message
/R Displays Registration order form (use SDIR /R >lpt1: to print it)
Using SuperDIR -- Command Summary (cont.)
-----------------------------------------
/A Attribute inclusion -- must give list of attributes to include
example: /Ahs
Default is normal/archived files, plus subdirectories
Valid attributes are:
h = hidden, s = system, r = read-only,
v = volume-ID, a = archive, d = subdirectories
n = do NOT show 'normal' files (eg. no attribs)
Note that if /Ad is used (w/out others), ONLY subdirs are listed.
Archive files and subdirs are normally listed, but use /Aa to
list the archive (& no-attrib) files WITHOUT the subdirectories.
/O Sorting order specification; also must give sort elements/order.
The order of the fields will determine the sorting priority.
Elements are:
n = name (without extension)
e = extension
s = size
d = date/time (with seconds)
a = attributes
g = (default) group sorts by subdirectory
(use g- to sort ALL files regardless of subdir.)
(sorting is always separate for each Path given)
Sort order is ascending by default, use '-' suffix to
specify descending order ('+' forces ascending order).
Note: The same criteria will apply to the order of
subdirectory traversal if the /S switch is used.
/F Format specification; also must give format type:
/Ff = Fully-formatted output (Default, like DIR command output)
/Fq = Quote-delimited output (eg. "name.c","1234","12:34p")
/Ft = Tab-delimited output (eg. for word processor import)
/Fs = Space-delimited output (eg. for piping to other programs)
Note: /Fq, /Ft, and /Fs must be followed by a list of elements.
This list will also specify the order. Elements are:
p = path (ie. drive:\dir\sub ...)
f = filename with extension
n = name (without extension)
e = extension
s = size (in bytes)
d = date
t = time (in hh:mma format)
m = military time, with seconds (hh:mm:ss)
a = attributes (listed as lower-case letters, like "ahrs")
x = full filename with path (eg c:\WINDOWS\WIN.INI)
l = level of subdirectory (root = 1)
example: /Fqpfs (result: "dive:\path\","file.ext","size")
Using SuperDIR -- Command Summary (cont.)
-----------------------------------------
These 3 switches are only valid for Fully-formatted (default) output:
/T Tab (indent) by subdirectory level (actually uses spaces, not tabs).
/B (Default) Add breaks/path names between subdir's. /-B to turn off
/Z (Default) Print size and file totals at the end. /-Z to turn off
Limitations
-----------
The DOS command line limits the number of switches, filters, etc. that can
be used. This problem will be addressed in the next release by allowing
a script file, environment settings, and perhaps an interactive input
option. (Get on our mailing list to receive a free update!) Note that you
can maximize switches by not putting spaces between them (a space is not
required between switches, only before the first switch).
Because recursion is used for traversing directory trees, you may encounter
a stack overflow if you use the /S switch and have too many levels deep
in your directory structure. This typically takes more than 20 levels to
be a problem. You will probably reach DOS's 80-character path limit
before this!
If you use a sorting command with the g- option (eg. /Ong-), you may
run out of memory. This usually only happens with over 3000 files (such
as when doing "SDIR /Ong- /S" in the root directory of a large drive).
If this happens, try removing the g-, or do one subdirectory at a time.
You may also try excluding files or directories that aren't needed (/X
and /E), or free up more memory by removing some TSR's. Future versions
will make use of Expanded/Extended memory. (Registered users will get
this update free when it's available, scheduled for July 1995!)
With minor changes, this program could be used to produce other formats,
such as space-delimited, DBF format, multi-column, etc. These might be
included in future releases, but you can also add these features yourself
if you register and get the complete source code!
Advanced uses
-------------
Because SDIR routes output to the standard output device, it's possible
to use its output as input to another program. An example of this would
be using SDIR to list all *.BAK files on your hard disk, and routing
that list to a program that deletes them. Use the space-delimited format
option (/Fs...) to output only the path and filename, and write a program
that takes those and does a DEL on them.
Other uses (some requiring simple auxiliary programs) include:
Printing out all FILE_ID.DIZ files and locations from a shareware CD.
Finding duplicate files (have SDIR sort so that they will be next to each
other so your programming part is easy), and printing a report of them.
Find all of the read-only or hidden files on a disk.
Find the total disk space used by certain file types (EXE, INI, etc.)
Let me know if you come up with other interesting uses, or if a change
to SuperDIR would make your life easier! Your input is appreciated!